<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>编码注释</title>
</head><body>[C/C++ COMMENTARY STYLE]<br/>
[C STYLE]<br/>
/**<br/>
&nbsp;* ...commentary...<br/>
&nbsp;*/<br/>
[C++ STYLE 1]<br/>
///<br/>
/// ...commentary...<br/>
///<br/>
[C++ STYLE 2]<br/>
//!<br/>
//! ...commentary...<br/>
//!<br/>
[QT STYLE]<br/>
/*!<br/>
&nbsp;* ...commentary...<br/>
&nbsp;*/<br/>
<br/>
[KEYS &amp; COMMANDS]<br/>
@file&#09;文件名.<br/>
@author&#09;作者信息.<br/>
@brief&#09;类/函数简易说明.<br/>
&#09;[用法]<br/>
&#09;/**<br/>
&#09; * @brief &lt;简单描述文字&gt;<br/>
&#09; * &#09;&lt;简单描述文字&gt;<br/>
&#09; * (中间要空一行)<br/>
&#09; * &lt;描述文字从这里开始&gt;<br/>
&#09; */<br/>
@param&#09;函数参数说明.<br/>
@return&#09;函数返回值说明.<br/>
@retval&#09;描述返回值类型.<br/>
@note&#09;注解.<br/>
@attention&#09;注意<br/>
@warning&#09;警告信息<br/>
@enum&#09;枚举<br/>
&#09;[用法]<br/>
&#09;@enum CTest::MyEnum (Doxygen会在该枚举处产生一个链接.)<br/>
@var&#09;引用了某个变量<br/>
&#09;用法同@enum<br/>
@class 引用了某个类<br/>
@exception&#09;可能产生异常的描述.<br/>
@date&#09;日期<br/>
<br/>
[VIM PLUGIN]<br/>
DoxygenToolkit.vim<br/>
[用法]<br/>
:DoxAuthor 打印文件头信息.<br/>
:Dox&#09;打印函数/变量/类注释.<br/>
</body></html>